De Filer API

Start met bouwen
Heeft u een account bij Filer? Log dan in zodat Filer eventueel specifieke settings voor uw account kan tonen. Inloggen
Bestanden
Bestanden zoeken Bestand downloaden Bestandsbijlagen downloaden Bestandsinhoud ophalen Bestand toevoegen Bestandsdata wijzigen Bestand hernoemen Bestand verwijderen Bestandsinformatie Bestandswijzigingen
Mappen
Map informatie Map synchroniseren Map inhoud
Handshakes
Handshake aanvragen
Antwoord afhandeling
Succesvol Waarschuwingen Waarschuwingscodes Fouten Foutcodes

Bestanden zoeken

GET https://api.file-search-engine.com/Search/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
Search STRING Geef de zoekterm op waar u op wilt zoeken
FileGroups[] ARRAY (STRING) Optioneel Geef de bestandsgroepen op waarbinnen u wilt zoeken. Eventueel andere bestandsgroepen zullen worden overgeslagen. Indien u geen bestandsgroepen opgeeft zal de zoekopdracht binnen alle bestandsgroepen worden uitgevoerd De bestandsgroepen dienen onderdeel te zijn van de opgegeven handshake
Limit INT Optioneel Geef het maximaal aantal resultaten per pagina op. Deze waarde overschrijft vervolgens uw standaard instelling Het opgegeven limiet dient te liggen tussen 5 en 250
Page INT Optioneel Geef het nummer van de pagina op welke u wilt laden. Filer houdt vervolgens zelf rekening met de juiste paginatie van uw resultaten
SortBy STRING Optioneel Geef de sortering van de resultaten op. Standaard wordt het resultaat gesorteerd op relevantie Relevance FileSize Date
SortOrder STRING Optioneel Geef de sorteervolgorde van de resultaten op. Standaard wordt het resultaat aflopend gesorteerd DESC ASC
ReturnFields[] ARRAY (STRING) Optioneel Geef de specifieke velden op die u terug wenst te krijgen. Indien u geen velden opgeeft zullen alle velden worden terug gegeven Durations CustomID Name Server Path Author FileGroup Type Dimension LastModified Deleted DeletedOn Downloadable TagsFound Meta Properties Attachments Snippet Score Pagination ShownResults

Verzoek

		
			curl -X GET -G https://api.file-search-engine.com/Search/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "Search=Filer year:2024" \
			-d "FileGroups[]=Example group"
            -d "FileGroups[]=Info Mailbox"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"Search" => "Filer year:2024",
				"FileGroups" => array(
					"Example group",
                    "Info Mailbox"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/Search/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Results": {
        "Count": 2,
        "Files": [
            {
                "CustomID": "5883739",
                "Name": "example.xls",
                "Server": "GOF001",
                "Path": {
                    "Show": "Filer example directory",
                    "Real": "GOFSERV001\\directory"
                },
                "Author": "Filer",
                "FileGroup": "Example group",
                "Type": "FILE",
                "Dimension": {
                    "Size": 28.9,
                    "Type": "kB"
                },
                "LastModified": "2024-12-03T18:50:13Z",
                "Deleted": true,
                "DeletedOn": "2024-12-03T19:00:13Z",
                "Downloadable": true,
                "Attachments": {
                    "Count": 1,
                    "Items": [
                        {
                            "Name": "2024.png",
                            "Downloadable": true,
                            "CreationDate": "2024-12-02T17:13:13Z"
                        }
                    ]
                },
                "TagsFound": [
                    "Tag1",
                    "Tag2"
                ],
                "Meta": {
                    "extra": "test file"
                },
                "Properties": null,
                "Snippet": "example file created by <snip>Filer<\/snip> to demonstrate the API",
                "Score": 5
            },
            {
                "CustomID": "1603290513319",
                "Name": "Re: Filer - 1733247013.eml",
                "Path": [
                    "GOF001",
                    "info@filer.eu",
                    "INBOX"
                ],
                "Author": "Filer info@filer.eu",
                "FileGroup": "Info Mailbox",
                "Type": "EMAIL",
                "Dimension": {
                    "Size": 32.58,
                    "Type": "kB"
                },
                "LastModified": "2024-12-03T18:30:13Z",
                "Deleted": false,
                "DeletedOn": null,
                "Downloadable": true,
                "Attachments": {
                    "Count": 1,
                    "Items": [
                        {
                            "Name": "Filer.png",
                            "Downloadable": true,
                            "CreationDate": "2024-12-02T01:09:13Z"
                        }
                    ]
                },
                "TagsFound": [],
                "Meta": null,
                "Properties": {
                    "Message-ID": "<09382507-2db942b6-1603285058-26379944339@mail.filer.eu>",
                    "Mailbox": "INBOX",
                    "Subject": "Re: Filer",
                    "From": {
                        "Name": "Filer",
                        "Address": "info@filer.eu"
                    },
                    "To": [
                        {
                            "Name": "Filer",
                            "Address": "info@filer.eu"
                        }
                    ],
                    "CC": [],
                    "BCC": []
                },
                "Snippet": "example e-mail sent by <snip>Filer<\/snip> to demonstrate the API",
                "Score": 5
            }
        ]
    },
    "Pagination": null,
    "ShownResults": {
        "Min": 1,
        "Max": 2
    },
    "Durations": {
        "Searching": 0.1,
        "Fetching": 0.4,
        "Parsing": 0.15,
        "Total": 0.65
    }
}

Bestand downloaden

GET https://api.file-search-engine.com/File/Download/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
FilePath STRING Geef de bestandslocatie op van het bestand dat u wilt downloaden
CustomID STRING Geef het unieke id op van het bestand dat u wilt downloaden. Het bestand kan ook worden gedownload via de bestandslocatie Het unieke id wordt enkel gebruikt indien het FilePath niet is opgegeven
FileGroup STRING Geef de bestandsgroep op waarbinnen u het bestand wilt downloaden De bestandsgroep dient onderdeel te zijn van de opgegeven handshake

Verzoek

		
			curl -X GET -G https://api.file-search-engine.com/File/Download/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_NbVhMn5eX8WuotQaob5gktfy9tC0NI7ktdPFOUsvcMnQDDy1o2gWvLT2Ff3ax8Joli29Ds2nEpCR2AToC7L5So8fR9GPHXB1" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroup=Example group"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_NbVhMn5eX8WuotQaob5gktfy9tC0NI7ktdPFOUsvcMnQDDy1o2gWvLT2Ff3ax8Joli29Ds2nEpCR2AToC7L5So8fR9GPHXB1",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroup" => "Example group"
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/File/Download/",
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_TxXsGZGBLZX5ihM0X3q5T6OXPEG0k0yBvT3B2HMMprPXZlX4mN9DTVlrjzrRzncuGe3HvNbkF0FmlmoW8yjZRUQBTHaQ4BIJ",
    "File": {
        "LastModified": "2024-12-03T18:50:13Z",
        "Dimension": {
            "Size": 5884,
            "Type": "B"
        },
        "Base64": "QkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBmaWxlIEJBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgZmlsZSBCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGZpbGUgQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBmaWxlIEJBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgZmlsZSBCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGZpbGUgQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBmaWxlIEJBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgZmlsZSBCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGZpbGUgQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBmaWxl"
    }
}

Bestandsbijlagen downloaden

GET https://api.file-search-engine.com/File/Download/Attachments/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
FilePath STRING Geef de bestandslocatie op van het hoofdbestand waarvan u bijlagen wilt downloaden
CustomID STRING Geef het unieke id op van het hoofdbestand waarvan u bijlagen wilt downloaden. Het hoofdbestand kan ook worden aangegeven via de bestandslocatie Het unieke id wordt enkel gebruikt indien het FilePath niet is opgegeven
FileGroup STRING Geef de bestandsgroep op waarbinnen u de bijlagen wilt downloaden De bestandsgroep dient onderdeel te zijn van de opgegeven handshake
AttachmentNames ARRAY (STRING) Geef de namen op van de bijlagen die u wilt downloaden

Verzoek

		
			curl -X GET -G https://api.file-search-engine.com/File/Download/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_NbVhMn5eX8WuotQaob5gktfy9tC0NI7ktdPFOUsvcMnQDDy1o2gWvLT2Ff3ax8Joli29Ds2nEpCR2AToC7L5So8fR9GPHXB1" \
			-d "FilePath=\\GOFSERV001\directory\example.pdf" \
			-d "FileGroup=Example group" \
			-d "AttachmentNames[]=Image001.png" \
			-d "AttachmentNames[]=Image002.png"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_NbVhMn5eX8WuotQaob5gktfy9tC0NI7ktdPFOUsvcMnQDDy1o2gWvLT2Ff3ax8Joli29Ds2nEpCR2AToC7L5So8fR9GPHXB1",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.pdf",
				"FileGroup" ="Example group",
				"AttachmentNames" => array(
					"Image001.png",
					"Image002.png"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/File/Download/",
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_TxXsGZGBLZX5ihM0X3q5T6OXPEG0k0yBvT3B2HMMprPXZlX4mN9DTVlrjzrRzncuGe3HvNbkF0FmlmoW8yjZRUQBTHaQ4BIJ",
    "Attachments": {
        "Image001.png": {
            "Dimension": {
                "Size": 1621,
                "Type": "B"
            },
            "Base64": "QkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAxLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMS5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDEucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAxLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMS5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDEucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAxLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMS5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDEucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAxLnBuZw=="
        },
        "Image002.png": {
            "Dimension": {
                "Size": 6327,
                "Type": "B"
            },
            "Base64": "QkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAyLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMi5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDIucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAyLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMi5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDIucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAyLnBuZ0JBU0U2NC1lbmNvZGVkIHN0cmluZyBvZiB0aGUgYXR0YWNobWVudCBJbWFnZTAwMi5wbmdCQVNFNjQtZW5jb2RlZCBzdHJpbmcgb2YgdGhlIGF0dGFjaG1lbnQgSW1hZ2UwMDIucG5nQkFTRTY0LWVuY29kZWQgc3RyaW5nIG9mIHRoZSBhdHRhY2htZW50IEltYWdlMDAyLnBuZw=="
        }
    }
}

Bestandsinhoud ophalen

GET https://api.file-search-engine.com/File/Content/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
FilePath STRING Geef de bestandslocatie op van het bestand waarvan u de inhoud wilt ophalen
CustomID STRING Geef het unieke id op van het bestand waarvan u de inhoud wilt ophalen. De inhoud van het bestand kan ook worden opgehaald via de bestandslocatie Het unieke id wordt enkel gebruikt indien het FilePath niet is opgegeven
FileGroup STRING Geef de bestandsgroep op voor de file waarvan u de inhoud wilt ophalen De bestandsgroep dient onderdeel te zijn van de opgegeven handshake

Verzoek

		
			curl -X GET -G https://api.file-search-engine.com/File/Content/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroup=Example group" \
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroup" => "Example group",
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/File/Content/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "PUT",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Content": "This is the content for the file processed by Filer"
}

Bestand toevoegen

POST https://api.file-search-engine.com/File/Add/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid U kunt een bestaand bestand updaten door het bestand nogmaals aan te bieden

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
FilePath STRING Geef de bestandslocatie op van het bestand dat u aan de wachtrij wilt toevoegen De bestandslocatie dient onderdeel te zijn van een opgegeven map binnen een bestandsgroep
FileGroup STRING Optioneel Geef de bestandsgroep op waarbinnen u het bestand wilt plaatsen. Eventueel andere bestandsgroepen waar het bestand onder zou kunnen vallen zullen worden overgeslagen. Indien u geen bestandsgroep opgeeft zal het bestand worden toegevoegd aan alle bestandsgroepen met een overeenkomende bestandsmap De bestandsgroep dient onderdeel te zijn van de opgegeven handshake
Priority INT Optioneel Geef de prioriteit op voor het bestand. Een hogere prioriteit geeft het bestand voorang over bestanden met een lagere prioriteit De opgegeven prioriteit dient te liggen tussen 0 en 1000
CustomID STRING Optioneel Geef een uniek ID op waarmee u het bestand later kunt identificeren
ExtraContent STRING Optioneel Geef tot maximaal 100.000 karakters op om toe te voegen aan de content van het bestand
Meta JSON Optioneel Geef extra gegevens op bij het het bestand. Filer zorgt er vervolgens voor dat deze metadata wordt aangeboden bij het opvragen van het bestand
Tags[] ARRAY (STRING) Optioneel Geef tags op bij het bestand zodat bestanden nog sneller en beter gevonden kunnen worden. Een tag dient te bestaan uit één woord zonder spaties van maximaal 30 tekens lang. Alle tags samen mogen niet meer dan 100.000 karakters bevatten Tijdens het zoeken naar bestanden worden de tags ook doorzocht waarbij gevonden zoektermen in de tags een zwaardere weging hebben dan gevonden zoektermen in de inhoud van het bestand

Verzoek

		
			curl -X POST -G https://api.file-search-engine.com/File/Add/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroup=Example group" \
			-d "CustomID=5883739" \
			-d "ExtraContent=Filer is awesome" \
			-d "Meta={\"wordcount\": 577382, \"extra\": \"example file\"}" \
			-d "Tags[]=Tag1" \
			-d "Tags[]=Tag2" \
			-d "Tags[]=Tag3"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroup" => "Example group",
				"CustomID" => "5883739",
				"ExtraContent" => "Filer is awesome",
				"Meta" => "{\"wordcount\": 577382, \"extra\": \"example file\"}",
				"Tags" => array(
					"Tag1",
					"Tag2",
					"Tag3",
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_POST => true,
					CURLOPT_POSTFIELDS => http_build_query($params),
					CURLOPT_URL => "https://api.file-search-engine.com/File/Add/",
					CURLOPT_CUSTOMREQUEST => "POST",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe"
}

Bestandsdata wijzigen

PUT https://api.file-search-engine.com/File/Change/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
FilePath STRING Geef de bestandslocatie op van het bestand waarvan u de ExtraContent, Meta-data en/of Tags wilt wijzigen
CustomID STRING Optioneel Geef het unieke id op van het bestand waarvan u de ExtraContent, Meta-data en/of Tags wilt wijzigen. Het bestand kan ook worden gewijzigd via de bestandslocatie Het unieke id wordt enkel gebruikt indien het FilePath niet is opgegeven
FileGroup STRING Optioneel Geef de bestandsgroep op waarbinnen u het bestand wilt wijzigen. Eventueel andere bestandsgroepen waar het bestand onder zou kunnen vallen zullen worden overgeslagen. Indien u geen bestandsgroep opgeeft zal het bestand worden gewijzigd in alle bestandsgroepen met een overeenkomende bestandsmap De bestandsgroep dient onderdeel te zijn van de opgegeven handshake
ExtraContent STRING Optioneel Geef tot maximaal 100.000 karakters op om toe te voegen aan de content van het bestand Geef de gegevens op waarmee het bestand moet worden bijgewerkt. Indien u dit veld niet meegeeft worden de oude gegevens van dit veld verwijderd. Let op dat de oude data volledig overschreven zal worden
Meta JSON Optioneel Geef extra gegevens op bij het het bestand. Filer zorgt er vervolgens voor dat deze metadata wordt aangeboden bij het opvragen van het bestand Geef de gegevens op waarmee het bestand moet worden bijgewerkt. Indien u dit veld niet meegeeft worden de oude gegevens van dit veld verwijderd. Let op dat de oude data volledig overschreven zal worden
Tags[] ARRAY (STRING) Optioneel Geef tags op bij het bestand zodat bestanden nog sneller en beter gevonden kunnen worden. Een tag dient te bestaan uit één woord zonder spaties van maximaal 30 tekens lang. Alle tags samen mogen niet meer dan 100.000 karakters bevatten Geef de gegevens op waarmee het bestand moet worden bijgewerkt. Indien u dit veld niet meegeeft worden de oude gegevens van dit veld verwijderd. Let op dat de oude data volledig overschreven zal worden

Verzoek

		
			curl -X PUT -G https://api.file-search-engine.com/File/Change/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroup=Example group" \
			-d "CustomID=5883739" \
			-d "ExtraContent=Filer is even more awesome" \
			-d "Meta={\"wordcount\": 577382, \"extra\": \"example file which has been changed\"}" \
			-d "Tags[]=Tag1_changed" \
			-d "Tags[]=Tag2_changed" \
			-d "Tags[]=Tag3_changed"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroup" => "Example group",
				"CustomID" => "5883739",
				"ExtraContent" => "Filer is even more awesome",
				"Meta" => "{\"wordcount\": 577382, \"extra\": \"example file which has been changed\"}",
				"Tags" => array(
					"Tag1_changed",
					"Tag2_changed",
					"Tag3_changed",
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/File/Change/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "PUT",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe"
}

Bestand hernoemen

PUT https://api.file-search-engine.com/File/Rename/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
FilePath STRING Geef de bestandslocatie op van het bestand dat u wilt hernoemen
CustomID STRING Geef het unieke id op van het bestand dat u wilt hernoemen. Het bestand kan ook worden hernoemd via de bestandslocatie Het unieke id wordt enkel gebruikt indien het FilePath niet is opgegeven
FilePathNew STRING Geef de nieuwe bestandslocatie op van het bestand
FileGroup STRING Optioneel Geef de bestandsgroep op waarbinnen u het bestand wilt hernoemen. Eventueel andere bestandsgroepen waar het bestand ook onder valt zullen worden overgeslagen. Indien u geen bestandsgroep opgeeft zal het bestand worden hernoemd binnen alle bestandsgroepen waar dit bestand onderdeel van uitmaakt De bestandsgroep dient onderdeel te zijn van de opgegeven handshake

Verzoek

		
			curl -X PUT -G https://api.file-search-engine.com/File/Rename/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FilePathNew=\\GOFSERV001\directory\example_new.xls" \
			-d "FileGroup=Example group"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FilePathNew" => "\\\\GOFSERV001\\directory\\example_new.xls",
				"FileGroup" => "Example group"
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/File/Rename/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "PUT",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_TxXsGZGBLZX5ihM0X3q5T6OXPEG0k0yBvT3B2HMMprPXZlX4mN9DTVlrjzrRzncuGe3HvNbkF0FmlmoW8yjZRUQBTHaQ4BIJ"
}

Bestand verwijderen

DELETE https://api.file-search-engine.com/File/Delete/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
FilePath STRING Geef de bestandslocatie op van het bestand dat u wilt verwijderen. Het bestand kan ook worden verwijderd via het unieke ID
CustomID STRING Optioneel Geef het unieke id op van het bestand dat u wilt verwijderen. Het bestand kan ook worden verwijderd via de bestandslocatie Het unieke id wordt enkel gebruikt indien het FilePath niet is opgegeven. Wanneer een bestand wordt verwijderd met het CustomID wordt het bestand direct geforceerd verwijderd, ongeacht uw back-up instellingen binnen de bestandsgroep
FileGroup STRING Optioneel Geef de bestandsgroep op waarbinnen u het bestand wilt verwijderen. Eventueel andere bestandsgroepen waar het bestand ook onder valt zullen worden overgeslagen. Indien u geen bestandsgroep opgeeft zal het bestand worden verwijderd binnen alle bestandsgroepen waar dit bestand onderdeel van uitmaakt De bestandsgroep dient onderdeel te zijn van de opgegeven handshake
Forced BOOL Optioneel Geef aan of het bestand per direct verwijdert dient worden, ongeacht uw back-up instellingen binnen de bestandsgroep

Verzoek

		
			curl -X DELETE -G https://api.file-search-engine.com/File/Delete/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroup=Example group"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroup" => "Example group"
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/File/Delete/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "DELETE",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_TxXsGZGBLZX5ihM0X3q5T6OXPEG0k0yBvT3B2HMMprPXZlX4mN9DTVlrjzrRzncuGe3HvNbkF0FmlmoW8yjZRUQBTHaQ4BIJ"
}

Bestandsinformatie

GET https://api.file-search-engine.com/File/Information/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
FilePath STRING Geef de bestandslocatie op van het bestand dat u wilt opvragen
CustomID STRING Optioneel Geef het unieke id op van het bestand dat u wilt opvragen. Het bestand kan ook worden opgevraagd via de bestandslocatie Het unieke id wordt enkel gebruikt indien het FilePath niet is opgegeven
FileGroups[] ARRAY (STRING) Optioneel Geef de bestandsgroepen op waarbinnen u de bestanden wilt opvragen. Eventueel andere bestandsgroepen waar het bestand onder zou kunnen vallen zullen worden overgeslagen. Indien u geen bestandsgroepen opgeeft zullen de bestanden worden opgevraagd binnen alle bestandsgroepen met een overeenkomende bestandsmap De bestandsgroepen dienen onderdeel te zijn van de opgegeven handshake

Verzoek

		
			curl -X GET -G https://api.file-search-engine.com/File/Information/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FilePath=\\GOFSERV001\directory\example.xls" \
			-d "FileGroups[]=Example group"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroups" => array(
					"Example group"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/File/Information/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Information": [
        {
            "CustomID": "5883739",
            "Server": "GOF001",
            "FileGroup": "Example group",
            "Type": "FILE",
            "Author": "Filer",
            "LastModified": "2024-12-02T20:06:13Z",
            "Deleted": true,
            "DeletedOn": "2024-12-03T19:00:13Z",
            "AddedBy": "Syncer",
            "UpdatedOn": "2024-12-03T16:02:13Z",
            "Processed": 1,
            "ProcessedOn": "2024-12-03T16:03:13Z",
            "InDictionary": 1,
            "AddedToDictionaryOn": "2024-12-03T16:04:13Z",
            "InAPIQueue": 0,
            "Downloadable": 1,
            "Attachments": {
                "Count": 1,
                "Items": [
                    {
                        "Name": "2024.png",
                        "Downloadable": true,
                        "CreationDate": "2024-12-02T17:13:13Z"
                    }
                ]
            },
            "Dimension": {
                "Size": 126.47,
                "Type": "kB"
            },
            "WordCount": {
                "Total": 25783,
                "Unique": 3364
            },
            "AverageWordLength": 11,
            "ContentLength": 265564,
            "ExtraContent": "Filer is awesome",
            "Meta": "{\"extra\":\"example file\"}",
            "Tags": [
                "Tag1",
                "Tag2",
                "Tag3"
            ],
            "Properties": null
        }
    ]
}

Bestandswijzigingen

GET https://api.file-search-engine.com/File/List/Changes/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
FileGroups[] ARRAY (STRING) Optioneel Geef de bestandsgroep op waarbinnen u de gewijzigde bestanden wilt opvragen. Eventueel andere bestandsgroepen waar bestanden zijn gewijzigd zullen worden overgeslagen. Indien u geen bestandsgroep opgeeft zullen de wijzigingen binnen alle bestandsgroepen worden opgevraagd De bestandsgroepen dienen onderdeel te zijn van de opgegeven handshake
MinuteWindow INT Geef op binnen welk minuten-window u de gewijzigde bestanden wilt opvragen Het minuten-window dient te liggen tussen 1 en 1440
TimeOffset DATETIME (STRING) Optioneel Geef op vanaf welk start-moment u de bestanden wilt opvragen. De bestanden vanaf het start-moment tot het eind van het minuten-window zullen vervolgens worden opgevraagd Indien u geen startmoment opgeeft worden de bestanden opgehaald voor de afgelopen minuten binnen het aangegeven minuten-window Gebruik het formaat: YYYY-mm-ddTHH:ii:ssZ in UTC
Limit INT Optioneel Geef op hoeveel gewijzigde bestanden u maximaal wilt opvragen Het aantal opgevraagde bestanden dient te liggen tussen 1 en 10.000

Verzoek

		
			curl -X GET -G https://api.file-search-engine.com/File/List/Changes/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FileGroups[]=Example group" \
			-d "TimeOffset=2024-12-03T16:02:13Z"
			-d "MinuteWindow=1440" \
			-d "Limit=1"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"FilePath" => "\\\\GOFSERV001\\directory\\example.xls",
				"FileGroups" => array(
					"Example group"
					),
				"TimeOffset" => "2024-12-03T16:02:13Z",
				"MinuteWindow" => 1440,
				"Limit" => 1
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/File/List/Changes/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Files": [
        {
            "CustomID": "5883739",
            "FileGroup": "Example group",
            "FilePath": "\\\\GOFSERV001\\directory\\example.xls",
            "LastModified": "2024-12-02T20:06:13Z",
            "UpdatedOn": "2024-12-03T16:36:13Z"
        }
    ]
}

Map informatie

GET https://api.file-search-engine.com/Directory/Information/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
Directory STRING Geef de map op waarvan u de informatie wilt ophalen
FileGroups[] ARRAY (STRING) Optioneel Geef de bestandsgroepen op waarbinnen de informatie opgehaald moet worden. Eventueel andere bestandsgroepen zullen worden overgeslagen. Indien u geen bestandsgroepen opgeeft zal de inhoud van alle bestandsgroepen worden opgehaald De bestandsgroepen dienen onderdeel te zijn van de opgegeven handshake

Verzoek

		
			curl -X GET -G https://api.file-search-engine.com/Directory/Information/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "Directory=\\GOFSERV001\subdirectory" \
			-d "FileGroups[]=Example group" \
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"Directory" => "\\\\GOFSERV001\\subdirectory",
				"FileGroups" => array(
					"Example group"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/Directory/Information/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Directories": {
        "Example group": [
            {
                "Type": "Automatically",
                "Synchronization": {
                    "Started": "2024-12-03T18:59:50Z",
                    "Completed": "2024-12-03T19:02:13Z",
                    "Duration": 143,
                    "Next": "2024-12-03T20:32:13Z",
                    "Requested": 0
                }
            }
        ]
    }
}

Map synchroniseren

PUT https://api.file-search-engine.com/Directory/Synchronize/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
Directory STRING Geef de map op waarvoor u een synchronisatie wilt aanvragen
FileGroups[] ARRAY (STRING) Optioneel Geef de bestandsgroepen op waarbinnen de synchronisatie aangevraagt moet worden. Eventueel andere bestandsgroepen zullen worden overgeslagen. Indien u geen bestandsgroepen opgeeft zal de synchronisatie van alle bestandsgroepen worden aangevraagd De bestandsgroepen dienen onderdeel te zijn van de opgegeven handshake

Verzoek

		
			curl -X PUT -G https://api.file-search-engine.com/Directory/Synchronize/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "Directory=\\GOFSERV001\subdirectory" \
			-d "FileGroups[]=Example group" \
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"Directory" => "\\\\GOFSERV001\\subdirectory",
				"FileGroups" => array(
					"Example group"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/Directory/Synchronize/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "PUT",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe"
}

Map inhoud

GET https://api.file-search-engine.com/Directory/List/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
Handshake STRING Geef uw handshake op om uw verzoek te authentiseren. Bekijk hoe u een handshake aanvraagt
Directory STRING Geef de map op waarvan u de directe inhoud wilt ophalen Enkel bestanden en sub-mappen die direct in deze map zitten worden terug gegeven
FileGroups[] ARRAY (STRING) Optioneel Geef de bestandsgroepen op waarbinnen de inhoud opgehaald moet worden. Eventueel andere bestandsgroepen zullen worden overgeslagen. Indien u geen bestandsgroepen opgeeft zal de inhoud van alle bestandsgroepen worden opgehaald De bestandsgroepen dienen onderdeel te zijn van de opgegeven handshake
LoadDeleted BOOL Optioneel Geef aan of verwijderde bestanden moeten worden teruggegeven. Standaard worden verwijderde bestanden niet teruggegeven Deze parameter heeft enkel invloed wanneer de back-up functionaliteit is ingeschakeld voor de opgevraagde bestandsgroep(en)

Verzoek

		
			curl -X GET -G https://api.file-search-engine.com/Directory/List/ \
			-d "CustomerID=2434" \
			-d "Handshake=API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "Directory=\\GOFSERV001\subdirectory" \
			-d "FileGroups[]=Example group" \
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"Handshake" => "API_To01HLJgEsMQr1RVM547Ud2EwXKoBUIdGGcYcvCooYCdYc8shAz9lzNhUfUe7mFO0ruck4PWbb97DFzuQy3BvOrQ2J295HV5",
				"Directory" => "\\\\GOFSERV001\\subdirectory",
				"FileGroups" => array(
					"Example group"
					)
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_URL => "https://api.file-search-engine.com/Directory/List/?".http_build_query($params),
					CURLOPT_CUSTOMREQUEST => "GET",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Subdirectories": {
        "Example group": [
            "\\\\GOFSERV001\\subdirectory\\subdirectory2",
            "\\\\GOFSERV001\\subdirectory\\subdirectory3"
        ]
    },
    "Files": {
        "Example group": [
            "example.xls",
            "example2.xls"
        ]
    }
}

Handshake aanvragen

POST https://api.file-search-engine.com/Handshake/Initialize/ Zie onderstaande lijst voor alle parameters om dit API-verzoek uit te kunnen voeren. Eventuele optionele parameters zullen worden aangeduid U dient enkel eenmalig een handshake aan te vragen via dit API-verzoek. Alle andere API-verzoeken geven een nieuwe handshake terug bij een succesvolle afhandeling

Parameters

CustomerID INT Geef uw klantnummer op om uw verzoek te authentiseren
SecretKey STRING Geef de hash van uw SecretKey op om uw verzoek te authentiseren. Hash aanmaken
FileGroups[] ARRAY (STRING) Geef de bestandsgroepen op waarbinnen de handshake mag worden gebruikt. Bestandsgroepen die niet worden opgegeven zullen automatisch worden uitgesloten

Verzoek

		
			curl -X POST -G https://api.file-search-engine.com/Handshake/Initialize/ \
			-d "CustomerID=2434" \
			-d "SecretKey=PWbb97DFzuQy3BvOrQ2J295HV5" \
			-d "FileGroups[]=Example group"
			
		
			$curl = curl_init();
			$params = array(
				"CustomerID" => 2434,
				"SecretKey" => "PWbb97DFzuQy3BvOrQ2J295HV5",
				"FileGroups" => array(
					"Example group"
					)		
				);
			curl_setopt_array($curl,
				array(
					CURLOPT_POST => true,
					CURLOPT_POSTFIELDS => http_build_query($params),
					CURLOPT_URL => "https://api.file-search-engine.com/Handshake/Initialize/",
					CURLOPT_CUSTOMREQUEST => "POST",
					CURLOPT_SSL_VERIFYPEER => false,
					CURLOPT_RETURNTRANSFER => true,
					CURLOPT_FOLLOWLOCATION => true,
					)
				);
			$response = json_decode(curl_exec($curl), true);
			curl_close($curl);
			
		

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_XZnY1Mc1dYYaSzbCDFPYKR2U66Hk3PZbwN7xhkwKGUsiRSsehFAzeDUkJlSM82x2N3z4nvN1OFjphZSOmcMQpq86bbRhdMj0"
}

Succesvol

Zie hieronder wat voor antwoord-structuur u kunt verwachten bij een succesvol afgehandeld API-verzoek

Antwoord

Een succesvol afgehandeld API-verzoek geeft een antwoord in JSON zoals hieronder weergegeven. Indien er extra parameters worden teruggegeven bij een API-verzoek, dan zal dit worden vermeld bij de desbetreffende API pagina
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe"
}

Waarschuwingen

Zie hieronder wat voor antwoord-structuur u kunt verwachten bij een afgehandeld API-verzoek waarbij waarschuwingen worden gemeld

Antwoord

Wanneer een API-verzoek één of meerdere waarschuwingen afgeeft, dan is het verzoek succesvol afgehandeld en is het antwoord gestructureerd zoals hieronder weergegeven
{
    "Status": "Success",
    "Handshake": "API_xrM1aPojZSonl6qyBMXR8MSlYS7E7xy2oJ4Mgs5FIs14yr07DXYKty3PQBdV8aXutbHZSMmkCnmAemHqJnAAlDZ9MBeSlCNe",
    "Warnings": [
        {
            "Warning": "...",
            "Code": 0
        },
        {
            "Warning": "...",
            "Code": 0
        },
        {
            "Warning": "...",
            "Code": 0
        }
    ]
}

Waarschuwingscodes

Hieronder worden alle waarschuwingscodes getoond met de bijbehorende melding
0 Algemene waarschuwing
1 Het bestand met het aangegeven unieke id wordt geforceerd verwijderd
2 Het opgegeven bestand kon niet worden gevonden in de aangegeven bestandsgroep
3 Het opgegeven bestand kon niet worden gevonden
4 De aangegeven bestandsgroep kon niet worden gevonden
5 Het aangegeven unieke id was al in gebruik. Het bestand zal worden bijgewerkt
6 Het aangegeven unieke id stond al in de wachtrij
7 De aangegeven bestandslocatie was al verwerkt. Het bestand zal worden bijgewerkt
8 De aangegeven bestandslocatie was al verwerkt op het aantal locaties dat wordt aangegeven. Het bestand zal worden bijgewerkt
9 Het aangegeven bestand is bijgewerkt in de wachtrij
10 De aangegeven installatie verwerkt momenteel niet via de API. Het bestand wordt niet toegevoegd aan de wachtrij
11 De bestandsgroep bestaat al. De instellingen van de bestandsgroep worden bijgewerkt
12 De bestandsgroep bestaat niet
13 Er kon geen bestand worden gevonden om te hernoemen binnen de aangegeven bestandsgroep
14 Er kon geen bestand worden gevonden om te hernoemen
15 De aangegeven sortering is niet een van de mogelijkheden om te sorteren. De getoonde resultaten zijn gesorteerd op relevantie
16 De aangegeven sorteringsvolgorde is niet een van de mogelijkheden. De getoonde resultaten worden aflopend gesorteerd
17 Het opgegeven limiet voldoet niet aan het aangegeven minimum limiet. Het minimum limiet is toegepast
18 Het opgegeven limiet voldoet niet aan het aangegeven maximale limiet. Het maximale limiet is toegepast
19 Het aangegeven veld is niet bekend en kan niet worden terug gegeven
20 De opgevraagde pagina heeft geen resultaten om te tonen
21 De aangegeven bestandsgroep is niet toegestaan voor dit verzoek doordat deze bestandsgroep is ingesteld om te verwerken via de API
22 De bestandslocatie komt overeen met een aangegeven service binnen de aangegeven bestandsgroep, maar de verwerkingsmethode van de service is niet ingesteld op API

Fouten

Zie hieronder wat voor antwoord-structuur u kunt verwachten bij een afgehandeld API-verzoek waarbij zich een fout heeft voorgedaan

Antwoord

Wanneer een API-verzoek een fout afgeeft, dan is het antwoord gestructureerd zoals hieronder weergegeven
{
    "Status": "Error",
    "Error": "...",
    "Code": 0
}

Foutcodes

Hieronder worden alle foutcodes getoond met de bijbehorende melding
0 Algemene fout
101 U heeft de REST-gebaseerde API aangeroepen met een verkeerde methode. Gebruik de aangegeven methode om verbinding te maken met de API voor dit verzoek
102 Voor het verzoek is een handshake verplicht, welke niet is meegegeven
103 Voor het verzoek is een bestandslocatie verplicht, welke niet is meegegeven
104 De opgegeven bestandslocatie is ongeldig
105 De maximale lengte van het CustomID is overschreden
106 De maximale lengte van de ExtraContent is overschreden
107 De opgegeven Metadata dient een geldig JSON-object te zijn
108 De aangegeven tag bestaat uit meerdere woorden. Een tag dient te bestaan uit één woord zonder spaties van maximaal 30 tekens lang
109 De maximale lengte van de Tags is overschreden
110 De bestandsgroep Filer_ALL is niet toegestaan voor dit specifieke verzoek
111 De aangegeven bestandsgroep kon niet worden gevonden
112 Het aangegeven unieke id is al in gebruik door een ander bestand in de aangegeven bestandsgroep
113 Het aangegeven unieke id is al in gebruik door een ander bestand
114 Er is een probleem met de database, probeer het opnieuw
115 Voor het verzoek is een naam voor de bestandsgroep verplicht, welke niet is meegegeven
116 Voor het verzoek zijn mappen om te verwerken verplicht, welke niet is meegegeven
117 Voor het verzoek is het verplicht om aan te geven of bestanden gekopieërd dienen te worden
118 Voor het verzoek is het verplicht om aan te geven of verwijderde bestanden behouden dienen te worden
119 Voor het verzoek is het verplicht om aan te geven hoe lang verwijderde bestanden behouden dienen te worden
120 Voor het verzoek is het verplicht om aan te geven wanneer de mappen in de bestandsgroep opnieuw moeten worden gesynchroniseerd
121 Voor het verzoek is het verplicht om de naam van de installatie op te geven waaran de bestandsgroep gekoppeld dient te worden
122 Voor het verzoek dient er minimaal één map om te verwerken worden opgegeven
123 Het aantal opgegeven te verwerken mappen komt niet overeen met de mappen om te tonen
124 De aangegeven map is geen sub-map van de te verwerken map
125 De aangegeven map is geen sub-map van de te verwerken mappen
126 De aangegeven map is geen sub-map van de te verwerken mappen
127 Het bestand kan niet hernoemd worden naar de huidige bestandsnaam
128 De handshake Filer_ALL kan alleen worden gebruikt wanneer de handshake geïnitialiseerd is met Filer_ALL
129 Voor het verzoek dient of de bestandslocatie of het unieke id opgegeven te worden
130 Het opgevraagde bestand kon niet worden gevonden
131 Voor het verzoek is een map verplicht, welke niet is meegegeven
132 De opgegeven map is ongeldig
133 De opgevraagde map kon niet worden gevonden
134 Voor het verzoek is de SecretKey verplicht, welke niet is meegegeven
135 De opgegeven SecretKey is ongeldig
136 Het gebruikte account is geblokkeerd
137 Om een handshake aan te vragen dient er minimaal één bestandsgroep opgegeven te worden waarbinnen acties mogen worden uitgevoerd met de aangevraagde handshake
138 De gebruikte methode voor het verzoek is onbekend
139 Voor het verzoek is het opgeven van bestandsgroepen verplicht, welke niet zijn meegegeven
140 Er konden geen overeenkomende bestandsgroepen gevonden worden voor uw verzoek
141 Er zijn geen actieve bestandsgroepen. Zorg dat er tenminste één actieve bestandsgroep is
142 Voor het verzoek is het opgeven van een bestandsgroep verplicht, welke niet is meegegeven
143 Er kon geen downloadbaar bestand gevonden worden voor uw verzoek
144 Er zijn meerdere downloadbare bestanden gevonden voor uw verzoek
145 Het opgevraagde bestand is een website-bestand en mag daardoor niet gedownload worden
146 Kon het verzoek tot downloaden van het bestand niet opslaan in de statistieken. De download is geannuleerd
147 Er is geen download beschikbaar voor het opgevraagde bestand
148 Er kon geen bestand gevonden worden voor uw verzoek
149 Het downloaden van bestanden is niet toegestaan
150 Voor het verzoek is het opgeven van een zoekopdracht verplicht, welke niet is meegegeven
151 Geef ten minste één van de aangegeven velden op als velden om terug te krijgen
152 Er zijn te veel resultaten gevonden voor uw zoekopdracht. Geef een nauwkeurigere zoekterm op
153 Voor het aangegeven woord zijn te veel mogelijkheden gevonden
154 Voor het aangegeven deel van de zoekopdracht zijn te veel mogelijkheden gevonden
203 De aangegeven bestandsgroep maakt geen onderdeel uit van uw handshake
204 Binnen de aangegeven bestandsgroep kon er geen overeenkomende map gevonden worden waar het aangegeven bestand onderdeel van uitmaakt
205 Er is geen bestandsgroep gevonden waar het aangegeven bestand onderdeel van uitmaakt
206 Er zijn meerdere mogelijkheden gevonden waar het unieke id aan toegekend kon worden. Zorg ervoor dat er maar één mogelijkheid is wanneer een uniek id wordt gebruikt
207 Het opgegeven aantal valt buiten het toegestane bereik
208 De aangegeven bestandsgroep is uitgeschakeld en kan niet worden gebruikt
209 Alle bestandsgroepen staan op non-actief
210 De aangegeven bestandsgroep is niet gekoppeld aan een installatie
211 Voor het verzoek zijn de namen van de bijlagen verplicht, welke niet zijn meegegeven
212 De aangegeven tag bestaat uit meer dan 30 tekens. De maximale lengte van een tag is 30 tekens en mag geen spaties bevatten
213 Er zijn te veel handshake-aanvragen in korte tijd verstuurd. Limiteer het aantal verzoeken of optimaliseer het API-gebruik door handshakes te gebruiken vanuit succesvolle antwoorden